appcompat/androidx.appcompat.widget/[main]SwitchCompat

SwitchCompat

open class SwitchCompat : CompoundButton, EmojiCompatConfigurationView(source)

(SESL variant) SwitchCompat is a complete backport of the core Switch widget that brings the visuals and functionality of the toggle widget to older versions of the Android platform. Unlike other widgets in this package, SwitchCompat is not automatically used in layouts that include the <Switch> element. Instead, you need to explicitly use <androidx.appcompat.widget.SwitchCompat> and the matching attributes in your layouts.

The thumb can be tinted with setThumbTintList and setThumbTintMode APIs as well as with the matching XML attributes. The track can be tinted with setTrackTintList and setTrackTintMode APIs as well as with the matching XML attributes.

Supported attributes include:

For more information, see the Toggle Buttons guide.

Inheritors

SeslToggleSwitch

Constructors

SwitchCompat

constructor(@NonNull context: @NonNull Context)

Construct a new Switch with default styling.

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet)

Construct a new Switch with default styling, overriding specific style attributes as requested.

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, defStyleAttr: Int)

Construct a new Switch with a default style determined by the given theme attribute, overriding specific style attributes as requested.

Properties

mTrackMargin

open var mTrackMargin: Int

SUPPORT_TOUCH_FEEDBACK

@RestrictTo(value = RestrictTo.Scope.LIBRARY_GROUP)

val SUPPORT_TOUCH_FEEDBACK: Boolean

Functions

canHapticFeedback

open fun canHapticFeedback(isChecked: Boolean): Boolean

draw

open fun draw(@NonNull c: @NonNull Canvas)

drawableHotspotChanged

open fun drawableHotspotChanged(x: Float, y: Float)

getCompoundPaddingLeft

open fun getCompoundPaddingLeft(): Int

getCompoundPaddingRight

open fun getCompoundPaddingRight(): Int

getCustomSelectionActionModeCallback

open fun getCustomSelectionActionModeCallback(): @Nullable ActionMode.Callback

getShowText

open fun getShowText(): Boolean

Indicates whether the on/off text should be displayed.

getSplitTrack

open fun getSplitTrack(): Boolean

Returns whether the track should be split by the thumb.

getSwitchMinWidth

open fun getSwitchMinWidth(): Int

Get the minimum width of the switch in pixels.

getSwitchPadding

open fun getSwitchPadding(): Int

Get the amount of horizontal padding between the switch and the associated text.

getTextOff

open fun getTextOff(): CharSequence

Returns the text displayed when the button is not in the checked state.

getTextOn

open fun getTextOn(): CharSequence

Returns the text displayed when the button is in the checked state.

getThumbDrawable

open fun getThumbDrawable(): Drawable

Get the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.

getThumbTextPadding

open fun getThumbTextPadding(): Int

Get the horizontal padding around the text drawn on the switch itself.

getThumbTintList

@Nullable

open fun getThumbTintList(): @Nullable ColorStateList

getThumbTintMode

open fun getThumbTintMode(): @Nullable PorterDuff.Mode

getTrackDrawable

open fun getTrackDrawable(): Drawable

Get the drawable used for the track that the switch slides within.

getTrackTintList

@Nullable

open fun getTrackTintList(): @Nullable ColorStateList

getTrackTintMode

open fun getTrackTintMode(): @Nullable PorterDuff.Mode

isEmojiCompatEnabled

open fun isEmojiCompatEnabled(): Boolean

jumpDrawablesToCurrentState

open fun jumpDrawablesToCurrentState()

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

onInitializeAccessibilityEvent

open fun onInitializeAccessibilityEvent(event: AccessibilityEvent)

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo)

onMeasure

open fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)

onPopulateAccessibilityEvent

open fun onPopulateAccessibilityEvent(event: AccessibilityEvent)

onTouchEvent

open fun onTouchEvent(ev: MotionEvent): Boolean

seslSetThumbStrokeColor

open fun seslSetThumbStrokeColor(@ColorInt color: Int)

seslSetTrackStrokeColor

open fun seslSetTrackStrokeColor(@ColorInt color: Int)

setAllCaps

open fun setAllCaps(allCaps: Boolean)

setChecked

open fun setChecked(checked: Boolean)

setCheckedWithoutAnimation

open fun setCheckedWithoutAnimation(checked: Boolean)

setCustomSelectionActionModeCallback

open fun setCustomSelectionActionModeCallback(actionModeCallback: @Nullable ActionMode.Callback)

See setCustomSelectionActionModeCallback

setEmojiCompatEnabled

open fun setEmojiCompatEnabled(enabled: Boolean)

Configure emoji fallback behavior using EmojiCompat.

setFilters

open fun setFilters(filters: @NonNull Array<InputFilter>)

setShowText

open fun setShowText(showText: Boolean)

Sets whether the on/off text should be displayed.

setSplitTrack

open fun setSplitTrack(splitTrack: Boolean)

Specifies whether the track should be split by the thumb.

setSwitchMinWidth

open fun setSwitchMinWidth(pixels: Int)

Set the minimum width of the switch in pixels.

setSwitchPadding

open fun setSwitchPadding(pixels: Int)

Set the amount of horizontal padding between the switch and the associated text.

setSwitchTextAppearance

open fun setSwitchTextAppearance(context: Context, resid: Int)

Sets the switch text color, size, style, hint color, and highlight color from the specified TextAppearance resource.

setSwitchTypeface

open fun setSwitchTypeface(typeface: Typeface)

Sets the typeface in which the text should be displayed on the switch.

open fun setSwitchTypeface(tf: Typeface, style: Int)

Sets the typeface and style in which the text should be displayed on the switch, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.

setTextOff

open fun setTextOff(textOff: CharSequence)

Sets the text displayed when the button is not in the checked state.

setTextOn

open fun setTextOn(textOn: CharSequence)

Sets the text displayed when the button is in the checked state.

setThumbDrawable

open fun setThumbDrawable(thumb: Drawable)

Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.

setThumbResource

open fun setThumbResource(resId: Int)

Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.